@react-md/list

@react-md/list

Create lists of content that can have optional supplementary icons, avatars, or images placed with the text.

Installation

npm install --save @react-md/list

It is also recommended to install the following packages as they normally work together well with lists:

npm install --save @react-md/theme \
  @react-md/typography \
  @react-md/divider \
  @react-md/avatar \
  @react-md/icon \
  @react-md/media

Documentation

You should check out the full documentation for live examples and more customization information, but an example usage is shown below.

Usage

import React from "react";
import { render } from "react-dom";
import { Divider } from "@react-md/divider";
import { List, ListItem } from "@react-md/list";
import { FontIcon } from "@react-md/icon";

const App = () => (
  <List>
    <ListItem id="item-1">Item 1</ListItem>
    <ListItem id="item-2" secondaryText="This is secondary text">
      Item 2 Primary Text
    </ListItem>
    <ListItem id="item-3" disabled>
      Item 3 Disabled
    </ListItem>
    <Divider />
    <ListSubheader>Sub actions</ListSubheader>
    <ListItem id="item-4" leftAddon={<FontIcon>close</FontIcon>}>
      Close
    </ListItem>
    <ListItem
      id="item-5"
      leftAddon={
        <Avatar
          src="https://picsum.photos/40?random"
          alt="A random image from https://picsum.photos"
        />
      }
      leftAddonType="avatar"
    >
      With Avatar
    </ListItem>
  </List>
);

render(<App />, document.getElementById("root"));

Changelog

3.1.0 (2021-09-10)

Bug Fixes

• @react-md/dialog: DialogFooter align prop applies correct classes (644971d)
• @react-md/form: TooManyFilesError is only used if all the other validation has passed (6ed3f54)
• @react-md/form: ensure file names end with a period for useFileUpload extensions (9238140)
• @react-md/form: prevent infinite rerenders when calling useFileUpload's reset in useEffect (b2875b1)
• @react-md/utils: useDropzone fix around onDragLeave behavior (fdff9f2)
• typescript: updated all array types to be readonly (8f71bcb)

Features

• @react-md/form: add isValidFileName option to useFileUpload (dbd0375)
• @react-md/typography: override default typography without globals (ce89374), closes #1239

Documentation

• react-md.dev: updated sassdoc for new module system (4746d26)
• react-md.dev: updated SortableColumns example to import SortOrder type (b629e3e)

Other Internal Changes

• ran yarn format to include new files (48d3d7f)
• Simplifying format and covering json and yml files (#1227) (045ba5e)
• @react-md/dev-utils: fixed spelling of gzipped (baad174)
• examples: updated nextjs examples to latest version of next (b50d745)
• react-md.dev: added sassdoc hot-reloading (9d58e09)
• react-md.dev: updated sassdoc examples to be linkable (9ed096e)
• react-md.dev: Updated fonts for latest nextjs build optimizations (ca9ecbd)
• typescript: support typescript@v4.4.2 (5a9dd72)